MergeWith(string[],string) Method

Summary

Merges this PDF file with one or more PDF existing files.

Syntax

C++/CLI

Java

Python

public void MergeWith( 
   string[] sourceFileNames, 
   string destinationFileName 
)

public void mergeWith( 
   java.lang.String[] string,  
   java.lang.String string 
);

public: 
void MergeWith(  
   array<String^>^ sourceFileNames, 
   String^ destinationFileName 
)

def MergeWith(self,sourceFileNames,destinationFileName):

Parameters

sourceFileNames

An array of System.String's that contain the names of the source files to merge with this PDFFile. Must not be null and must contain at least one item and a maximum of 100 items.

destinationFileName

Name of the destination PDF file to be created. If the value of this parameter is null (Nothing in VB) then the filename set in FileName will be updated.

Remarks

This method will merge two or more existing PDF files to form a new file containing all the pages from the pre-existing PDF files. The new file will be constructed as follows:

The pages of the PDF file associated with this PDFFile object will be first.
The pages of the first file in the sourceFileNames list will be appended next.
The pages of the second file in the sourceFileNames list will be appended next.
And so on for each item in sourceFileNames .

When using the MergeWith method, it is important to ensure that the initialPath property is set to the same directory as the Pdf.Utilities.dll.

All PDF files must pre-exist on disk and must be valid. The sourceFileNames parameter must not contain any null items.

To use this method, associate this PDFFile object with a valid PDF file and optional password. You can achieve this by either using the PDFFile(string fileName) or PDFFile(string fileName, string password) constructors or set the filename and optional password directly into the FileName and Password properties. You do not need to call Load before using this method.

This method will use the following properties of this PDFFile object:

DocumentProperties. If the value of DocumentProperties is null, then the default properties will be used.
SecurityOptions. If the value of SecurityOptions is not null, then the destination file will be encrypted using the SecurityOptions properties. If the value of SecurityOptions is null, the resulting file will not be encrypted.
CompatibilityLevel. The version of the generated PDF file

If one or more of the files to merge with are encrypted with a password, then use the MergeWith(PDFFile[] sourceFiles, string destinationFileName) version of this method to pass a list of PDFFile objects instead of just the filenames, and thus, associating each input item with an optional password.

If you wish to merge only a portion (not all the pages) of one or more PDF files, you can use the PDFFile.MergeFiles method instead.

Example

This example will merge a group of PDF files to generate a single document that contains all the pages.

using Leadtools.WinForms; 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
 
 
public void PDFFileMergeWithExample() 
{ 
   string sourceFileName1 = Path.Combine(LEAD_VARS.ImagesDir, @"File1.pdf"); 
   string sourceFileName2 = Path.Combine(LEAD_VARS.ImagesDir, @"File2.pdf"); 
   string sourceFileName3 = Path.Combine(LEAD_VARS.ImagesDir, @"File3.pdf"); 
 
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Merged.pdf"); 
 
   // Merge 1 with (2, 3) and form destination 
   PDFFile pdfFile = new PDFFile(sourceFileName1); 
   pdfFile.MergeWith(new string[] { sourceFileName2, sourceFileName2 }, destinationFileName); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms